<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>simvoc.input.map_format_writer.MapWriter</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="simvoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >SimVOC</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="simvoc-module.html">Package&nbsp;simvoc</a> ::
        <a href="simvoc.input-module.html">Package&nbsp;input</a> ::
        <a href="simvoc.input.map_format_writer-module.html">Module&nbsp;map_format_writer</a> ::
        Class&nbsp;MapWriter
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class MapWriter</h1><p class="nomargin-top"><span class="codelink"><a href="simvoc.input.map_format_writer-pysrc.html#MapWriter">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_simvoc_i_8" name="uml_class_diagram_for_simvoc_i_8">
<area shape="rect" id="node159" href="simvoc.input.map_format_writer.MapWriter-class.html#__init__" title="x.__init__(...) initializes x; see x.__class__.__doc__ for signature" alt="" coords="17,209,372,228"/>
<area shape="rect" id="node159" href="simvoc.input.map_format_writer.MapWriter-class.html#add_ce" title="Adds a Compute Element to the grid, which will result in the creation of a &#160;Site internally." alt="" coords="17,228,372,247"/>
<area shape="rect" id="node159" href="simvoc.input.map_format_writer.MapWriter-class.html#remove_ce" title="Removes a CE from the grid." alt="" coords="17,247,372,265"/>
<area shape="rect" id="node159" href="simvoc.input.map_format_writer.MapWriter-class.html#grow_cluster" title="Adds machines to a cluster." alt="" coords="17,265,372,284"/>
<area shape="rect" id="node159" href="simvoc.input.map_format_writer.MapWriter-class.html#shrink_cluster" title="Removes machines from a cluster." alt="" coords="17,284,372,303"/>
<area shape="rect" id="node1" href="simvoc.input.map_format_writer.MapWriter-class.html" title="Mechanism for writing dynamic grid map files readable by the core map_format_reader module." alt="" coords="5,177,384,309"/>
<area shape="rect" id="node160" href="simvoc.input.common_writer.CommonWriter-class.html#write_time" title="Writes a clock timestamp to the output file, after which a record may be &#160;written." alt="" coords="76,39,313,57"/>
<area shape="rect" id="node160" href="simvoc.input.common_writer.CommonWriter-class.html#write_meta" title="Writes a single metadata record to the output file handle" alt="" coords="76,57,313,76"/>
<area shape="rect" id="node160" href="simvoc.input.common_writer.CommonWriter-class.html#write_meta_comment" title="Writes a metadata comment to the output file handle." alt="" coords="76,76,313,95"/>
<area shape="rect" id="node160" href="simvoc.input.common_writer.CommonWriter-class.html#write_line_comment" title="Writes a line comment to the output file handle." alt="" coords="76,95,313,113"/>
<area shape="rect" id="node160" href="simvoc.input.common_writer.CommonWriter-class.html#write_blank" title="Writes a blank line to the output file handle" alt="" coords="76,113,313,132"/>
<area shape="rect" id="node160" href="simvoc.input.common_writer.CommonWriter-class.html#check_time" title="Ensures that a call to write_time has been performed." alt="" coords="76,132,313,151"/>
<area shape="rect" id="node2" href="simvoc.input.common_writer.CommonWriter-class.html" title="simvoc.input.common_writer.CommonWriter" alt="" coords="64,6,325,157"/>
</map>
  <img src="uml_class_diagram_for_simvoc_i_8.gif" alt='' usemap="#uml_class_diagram_for_simvoc_i_8" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>Mechanism for writing dynamic grid map files readable by the core 
  map_format_reader module. Writing map entries is a multi-step process, 
  which usually begins with a call to write_time() to set the timestamp of 
  the current map change. Maps are then produced by calls to add_ce(), 
  remove_ce(), grow_cluster(), and shrink_cluster(). New clusters are 
  automatically created when grow_cluster() is called with a name not yet 
  known to the grid. Similarly, schedulers are added whenever add_ce 
  specifies a scheduler not yet in use.</p>
  <p>The grid map is NOT buffered in RAM, which should allow for the 
  creation of large map files without swapping. However, the portion of the
  grid that is actually in use for simulation purposes must be loaded into 
  RAM, which will limit maximum simulation size.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.input.map_format_writer.MapWriter-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">fh</span>,
        <span class="summary-sig-arg">normalize_time</span>=<span class="summary-sig-default">False</span>)</span><br />
      x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.map_format_writer-pysrc.html#MapWriter.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.input.map_format_writer.MapWriter-class.html#add_ce" class="summary-sig-name">add_ce</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">ce_name</span>,
        <span class="summary-sig-arg">cluster_name</span>,
        <span class="summary-sig-arg">sched_name</span>)</span><br />
      Adds a Compute Element to the grid, which will result in the creation
      of a Site internally.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.map_format_writer-pysrc.html#MapWriter.add_ce">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.input.map_format_writer.MapWriter-class.html#remove_ce" class="summary-sig-name">remove_ce</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">ce_name</span>)</span><br />
      Removes a CE from the grid.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.map_format_writer-pysrc.html#MapWriter.remove_ce">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.input.map_format_writer.MapWriter-class.html#grow_cluster" class="summary-sig-name">grow_cluster</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">cluster_name</span>,
        <span class="summary-sig-arg">cpu_count</span>,
        <span class="summary-sig-arg">profile_name</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
      Adds machines to a cluster.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.map_format_writer-pysrc.html#MapWriter.grow_cluster">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.input.map_format_writer.MapWriter-class.html#shrink_cluster" class="summary-sig-name">shrink_cluster</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">cluster_name</span>,
        <span class="summary-sig-arg">cpu_count</span>)</span><br />
      Removes machines from a cluster.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.map_format_writer-pysrc.html#MapWriter.shrink_cluster">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.input.common_writer.CommonWriter-class.html#check_time" class="summary-sig-name">check_time</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Ensures that a call to write_time has been performed.
      <em>(Inherited from <a href="simvoc.input.common_writer.CommonWriter-class.html">simvoc.input.common_writer.CommonWriter</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.common_writer-pysrc.html#CommonWriter.check_time">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="write_blank"></a><span class="summary-sig-name">write_blank</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Writes a blank line to the output file handle
      <em>(Inherited from <a href="simvoc.input.common_writer.CommonWriter-class.html">simvoc.input.common_writer.CommonWriter</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.common_writer-pysrc.html#CommonWriter.write_blank">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.input.common_writer.CommonWriter-class.html#write_line_comment" class="summary-sig-name">write_line_comment</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">comment</span>)</span><br />
      Writes a line comment to the output file handle.
      <em>(Inherited from <a href="simvoc.input.common_writer.CommonWriter-class.html">simvoc.input.common_writer.CommonWriter</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.common_writer-pysrc.html#CommonWriter.write_line_comment">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.input.common_writer.CommonWriter-class.html#write_meta" class="summary-sig-name">write_meta</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>,
        <span class="summary-sig-arg">value</span>)</span><br />
      Writes a single metadata record to the output file handle
      <em>(Inherited from <a href="simvoc.input.common_writer.CommonWriter-class.html">simvoc.input.common_writer.CommonWriter</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.common_writer-pysrc.html#CommonWriter.write_meta">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.input.common_writer.CommonWriter-class.html#write_meta_comment" class="summary-sig-name">write_meta_comment</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">comment</span>)</span><br />
      Writes a metadata comment to the output file handle.
      <em>(Inherited from <a href="simvoc.input.common_writer.CommonWriter-class.html">simvoc.input.common_writer.CommonWriter</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.common_writer-pysrc.html#CommonWriter.write_meta_comment">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.input.common_writer.CommonWriter-class.html#write_time" class="summary-sig-name">write_time</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">timeval</span>,
        <span class="summary-sig-arg">is_offset</span>=<span class="summary-sig-default">False</span>)</span><br />
      Writes a clock timestamp to the output file, after which a record may
      be written.
      <em>(Inherited from <a href="simvoc.input.common_writer.CommonWriter-class.html">simvoc.input.common_writer.CommonWriter</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.common_writer-pysrc.html#CommonWriter.write_time">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">fh</span>,
        <span class="sig-arg">normalize_time</span>=<span class="sig-default">False</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.input.map_format_writer-pysrc.html#MapWriter.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>x.__init__(...) initializes x; see x.__class__.__doc__ for 
  signature</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>fh</code></strong> - Open file handle (w mode) to which map will be written</li>
        <li><strong class="pname"><code>normalize_time</code></strong> (bool) - if True, all timestamps will be normalized relative to the first 
          timestamp written</li>
    </ul></dd>
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="add_ce"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">add_ce</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">ce_name</span>,
        <span class="sig-arg">cluster_name</span>,
        <span class="sig-arg">sched_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.input.map_format_writer-pysrc.html#MapWriter.add_ce">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Adds a Compute Element to the grid, which will result in the creation 
  of a Site internally. The specified cluster must exist prior to adding 
  the CE, otherwise a simulation run-time error will occur. In addition, CE
  names MUST be unique across a single simulation.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>ce_name</code></strong> (str) - Name of the CE to add</li>
        <li><strong class="pname"><code>cluster_name</code></strong> (str) - Name of the cluster providing machines to this CE</li>
        <li><strong class="pname"><code>sched_name</code></strong> (str) - Name of the scheduler to which this CE will send jobs. If the 
          scheduler does not yet exist, it will be created using the name 
          translator specified in the simulation driver.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="remove_ce"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">remove_ce</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">ce_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.input.map_format_writer-pysrc.html#MapWriter.remove_ce">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Removes a CE from the grid. All jobs running on all schedulers 
  associated with the CE will be killed at the time the CE is removed.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>ce_name</code></strong> (str) - Computing Element (site) name to remove from the grid</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="grow_cluster"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">grow_cluster</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">cluster_name</span>,
        <span class="sig-arg">cpu_count</span>,
        <span class="sig-arg">profile_name</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.input.map_format_writer-pysrc.html#MapWriter.grow_cluster">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Adds machines to a cluster. If the cluster does not exist, it will be 
  created automatically. Cluster names MUST be unique across the 
  simulation, or errors will occur. An optional profile name allows 
  experiments to use different types or configurations of machines in 
  simulation runs.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>cluster_name</code></strong> (str) - Name of cluster to create or enlarge</li>
        <li><strong class="pname"><code>cpu_count</code></strong> (int) - Number of CPU cores to add</li>
        <li><strong class="pname"><code>profile_name</code></strong> (str) - Optional machine profile name</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="shrink_cluster"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">shrink_cluster</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">cluster_name</span>,
        <span class="sig-arg">cpu_count</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.input.map_format_writer-pysrc.html#MapWriter.shrink_cluster">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Removes machines from a cluster. An error will occur at simulation 
  time if a negative number of machines is reached, but it is permissible 
  to reduce a cluster to zero size. When shrinking a cluster, any available
  idle nodes will be removed first. If the specified number of CPU cores 
  exceeds the idle count, other nodes will be selected randomly (using the 
  simulator's random source) for removal. Jobs running on the selected 
  nodes will be killed immediately.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>cluster_name</code></strong> (str) - Name of cluster to shrink</li>
        <li><strong class="pname"><code>cpu_count</code></strong> (int) - Number of CPU cores to remove</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="simvoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >SimVOC</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0 on Fri Oct 23 11:04:35 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
